Skip to main content
GET
[Instances] List all compute instances

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <token> header. Token can be a JWT token or an API key (format: sk-onetsolutions-...).

Path Parameters

organization_id
string
required

Unique identifier of the organization that owns the resource.

project_id
string
required

Unique identifier of the project containing the resource.

Query Parameters

is_active
enum<string>

true (default): instances not cancelled nor terminated; false: only those; all: both.

Available options:
all,
false,
true
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

status
string

Comma-separated instance statuses to keep, among: pending, provisioning, active, suspended, terminated, cancelled, error. Omitted, every status is listed.

Response

List of instances retrieved successfully